peril.ai

Class AI

java.lang.Object

peril.ai.AI

public abstract class AI
extends java.lang.Object

An AI player of the game. This AI will perform an action based on the current state of the Board and the current state of the game. Any concrete instances of this must be state-less as the may be used by multiple Players.

Since:

2018-03-08

Version:

1.01.02

Author:

Joshua_Eddy

See Also:

AIController

Field Summary

Fields

Modifier and Type	Field and Description
private AIController	api The AIController that this AI will use to query the state of the game.
private java.util.concurrent.Callable<AIOperation>	attack The Callable which invokes the processAttack(AIController).
private java.util.function.Function<AIOperation,java.lang.Boolean>	completeAttack The Function that is called when attack is completed.
private java.util.function.Function<AIOperation,java.lang.Boolean>	completeFortify The Function that is called when fortify is completed.
private java.util.function.Function<AIOperation,java.lang.Boolean>	completeReinforce The Function that is called when reinforce is completed.
private java.util.concurrent.ExecutorService	executor The Executor that performs the AI operations.
private java.util.concurrent.Callable<AIOperation>	fortify The Callable which invokes the processFortify(AIController).
private java.util.concurrent.Future<AIOperation>	future The result of the AI operation on another thread.
static int	MAX_SPEED The minimum number of milliseconds between each action of this AI.
java.lang.String	name The name of this AI.
private java.util.concurrent.Callable<AIOperation>	reinforce The Callable which invokes the processReinforce(AIController).
private int	speed The number of milliseconds between each action of this AI.
static AI	USER The AI for a user controlled player.
private int	wait The number of milliseconds that this AI will wait before performing another operation.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AI() Constructs the USER.
	AI(java.lang.String name, int defaultSpeed, AIController api) Constructs a new AI.

Method Summary

Modifier and Type	Method and Description
boolean	attack(int delta) Performs the attack operations of this AI.
boolean	fortify(int delta) Performs the fortify operations of this AI.
int	getSpeed() Retrieves the speed of this AI.
private boolean	performOperation(java.util.concurrent.Callable<AIOperation> operation, java.util.function.Function<AIOperation,java.lang.Boolean> onComplete) Performs the specified Callable operation and stored the result in future.
protected abstract AIOperation	processAttack(AIController api) Perform the attack operation using the specified AIController.
protected abstract AIOperation	processFortify(AIController api) Perform the fortify operation using the specified AIController.
protected abstract AIOperation	processReinforce(AIController api) Perform the reinforce operation using the specified AIController.
boolean	reinforce(int delta) Performs the reinforce operations of this AI.
void	setSpeed(int speed) Set the number of milliseconds between each action of this AI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER

public static final AI USER

The AI for a user controlled player. This AI does not support any operations and therefore can be used to detect a user controlled player.

MAX_SPEED

public static final int MAX_SPEED

The minimum number of milliseconds between each action of this AI.

See Also:

Constant Field Values

name

public final java.lang.String name

The name of this AI.

api

private final AIController api

The AIController that this AI will use to query the state of the game.

reinforce

private final java.util.concurrent.Callable<AIOperation> reinforce

The Callable which invokes the processReinforce(AIController).

completeReinforce

private final java.util.function.Function<AIOperation,java.lang.Boolean> completeReinforce

The Function that is called when reinforce is completed.

attack

private final java.util.concurrent.Callable<AIOperation> attack

The Callable which invokes the processAttack(AIController).

completeAttack

private final java.util.function.Function<AIOperation,java.lang.Boolean> completeAttack

The Function that is called when attack is completed.

fortify

private final java.util.concurrent.Callable<AIOperation> fortify

The Callable which invokes the processFortify(AIController).

completeFortify

private final java.util.function.Function<AIOperation,java.lang.Boolean> completeFortify

The Function that is called when fortify is completed.

executor

private final java.util.concurrent.ExecutorService executor

The Executor that performs the AI operations.

wait

private int wait

The number of milliseconds that this AI will wait before performing another operation.

speed

private int speed

The number of milliseconds between each action of this AI. If this is zero or lower then the then the AI will perform its actions at the frame rate of the display.

future

private java.util.concurrent.Future<AIOperation> future

The result of the AI operation on another thread.

Constructor Detail

AI

public AI(java.lang.String name,
          int defaultSpeed,
          AIController api)

Constructs a new AI.

Parameters:

name - The name of this AI.

defaultSpeed - The number of milliseconds between each action of this AI. If this is zero or lower then the then the AI will perform its actions at the frame rate of the display.

api - The AIController that this AI will use to query the state of the game.

AI

private AI()

Constructs the USER.

Method Detail

reinforce

public final boolean reinforce(int delta)

Performs the reinforce operations of this AI.

Parameters:

delta - The time (in milliseconds) that has elapsed since the last time this method was called.

Returns:

Whether or not this AI wishes to perform another operation or not.

attack

public final boolean attack(int delta)

Performs the attack operations of this AI.

Parameters:

delta - The time (in milliseconds) that has elapsed since the last time this method was called.

Returns:

Whether or not this AI wishes to perform another operation or not.

fortify

public final boolean fortify(int delta)

Performs the fortify operations of this AI.

Parameters:

delta - The time (in milliseconds) that has elapsed since the last time this method was called.

Returns:

Whether or not this AI wishes to perform another operation or not.

setSpeed

public final void setSpeed(int speed)

Set the number of milliseconds between each action of this AI.

Parameters:

speed - The new speed of the AI.

getSpeed

public final int getSpeed()

Retrieves the speed of this AI.

Returns:

AI speed.

processReinforce

protected abstract AIOperation processReinforce(AIController api)

Perform the reinforce operation using the specified AIController. This operation should be specific to the specialised instance of the AI.

Key aspects:

• Only reinforce the selected Country ONCE.
• The operation should be completely functional and rely on ANY data that is not provided by the AIController.
• The selected Country must be owned by the current Player which can be retrieved using AIController.getCurrentPlayer().

This method must:

1. Select a Country by adding one Country to AIOperation.select that is returned.
2. Set AIOperation.processAgain, which is whether or not this AI wishes to perform another operation or not. If not the AIController

Parameters:

api - AIController

Returns:

The AIOperation for this AI's reinforce.

processAttack

protected abstract AIOperation processAttack(AIController api)

Perform the attack operation using the specified AIController. This operation should be specific to the specialised instance of the AI.

Key aspects:

• Only attack the target Country ONCE.
• The operation should be completely functional and rely on NO data that is not provided by the AIController.
• The primary Country should have more than a one unit army.
• The primary Country that is selected must be owned by the current Player.
• The target Country should be a neighbour of the primary Country and owned by another Player.

This method must:

1. Select a primary Country by adding it first to AIOperation.select that is returned.
2. Select a target Country by adding it second to AIOperation.select that is returned.
3. Set AIOperation.processAgain, which is whether or not this AI wishes to perform another operation or not. If not the AIController

The order that the Countrys are selected matters. The primary Country MUST be selected first.

Parameters:

api - AIController

Returns:

The AIOperation for this AI's attack.

processFortify

protected abstract AIOperation processFortify(AIController api)

Perform the fortify operation using the specified AIController. This operation should be specific to the specialised instance of the AI.

Key aspects:

• Only fortify the target Country ONCE.
• The operation should be completely functional and rely on NO data that is not provided by the AIController.
• The primary Country must have more than a one unit army.
• The primary and target Countrys must be owned by the same Player.
• The target Country must have a valid path between is and the primary Country. Use AIController.isPathBetween(Country, Country) to check this.

This method must:

1. Select a primary Country by adding it first to AIOperation.select that is returned.
2. Select a target Country by adding it second to AIOperation.select that is returned.
3. Set AIOperation.processAgain, which is whether or not this AI wishes to perform another operation or not. If not the AIController

The order that the Countrys are selected matters. The primary Country MUST be selected first.

Parameters:

api - AIController

Returns:

The AIOperation for this AI's fortify.

performOperation

private boolean performOperation(java.util.concurrent.Callable<AIOperation> operation,
                                 java.util.function.Function<AIOperation,java.lang.Boolean> onComplete)

Performs the specified Callable operation and stored the result in future. When future Future.isDone() this method will perform the specified Function .

Parameters:

operation - The Callable that contains the AIs calculations.

onComplete - The Function that will be performed when the operation is completed.

Returns:

Whether or not this AI wishes to perform another operation or not.